Skip to content

docs: Use serverpod start in provider docs#591

Open
Zfinix wants to merge 3 commits into
mainfrom
chore/use-serverpod-start-in-provider-docs
Open

docs: Use serverpod start in provider docs#591
Zfinix wants to merge 3 commits into
mainfrom
chore/use-serverpod-start-in-provider-docs

Conversation

@Zfinix

@Zfinix Zfinix commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Replaces dart run bin/main.dart --apply-migrations with serverpod start across the Google, Apple, GitHub, and Firebase provider docs (setup + troubleshooting). The explicit forms stay documented on the migrations reference and the --role maintenance / --apply-repair-migration callsites.

Part of #565

…rpod start' instead of 'dart run bin/main.dart --apply-migrations'
@Zfinix Zfinix self-assigned this Jun 10, 2026
Comment thread docs/06-concepts/11-authentication/04-providers/03-google/01-setup.md Outdated
@Zfinix Zfinix marked this pull request as draft June 10, 2026 11:25
@Zfinix Zfinix marked this pull request as ready for review June 11, 2026 08:39
@Zfinix Zfinix requested a review from developerjamiu June 11, 2026 09:19
@Swiftaxe

Copy link
Copy Markdown
Collaborator

It should say "Part of", not "Closes" in the PR description, right?

@Zfinix

Zfinix commented Jun 11, 2026

Copy link
Copy Markdown
Contributor Author

Hmm it could be that also but this touches all the places we have that in the next doc except migrations

- [ ] Add `FirebaseIdpConfigFromPasswords()` to `identityProviderBuilders` in `server.dart`.
- [ ] Create a `FirebaseIdpEndpoint` file in `lib/src/auth/` extending `FirebaseIdpBaseEndpoint`.
- [ ] Run **`serverpod generate`**, then **`serverpod create-migration`**, then apply migrations with `dart run bin/main.dart --apply-migrations`.
- [ ] Run **`serverpod generate`**, then **`serverpod create-migration`**, then start the server with `serverpod start`.

@developerjamiu developerjamiu Jun 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following up on @Swiftaxe earlier note: Google, Apple, and GitHub were all fully converted to serverpod start, but Firebase still has the explicit serverpod generate + serverpod create-migration chain. If serverpod start handles those (as the rest of the PR assumes), Firebase should match.

Suggested change
- [ ] Run **`serverpod generate`**, then **`serverpod create-migration`**, then start the server with `serverpod start`.
- [ ] Start the server with `serverpod start`.

- [ ] Add `GoogleIdpConfigFromPasswords()` to `identityProviderBuilders` in `server.dart`.
- [ ] Create a `GoogleIdpEndpoint` file in `lib/src/auth/`.
- [ ] Run `serverpod generate`, then `serverpod create-migration`, then apply migrations using `--apply-migrations`.
- [ ] Started the server with `serverpod start`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tense mix here: the new Started the server with serverpod start. is past tense next to imperative siblings (Add, Create). GitHub's checklist is already all past tense, which reads more naturally for a "what have you done" checkbox list. Two options:

  • Convert the rest of the list to past tense (matches GitHub).
  • Keep imperative on the new line for consistency with the existing items: Start the server with serverpod start.

Either resolves the inconsistency.

* [ ] Call **`pod.configureAppleIdpRoutes(...)`** on the server before the pod starts.
* [ ] Create an `AppleIdpEndpoint` file in `lib/src/auth/`.
* [ ] Run **`serverpod generate`**, then apply migrations using `--apply-migrations`.
* [ ] Started the server with `serverpod start`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same tense mix as in the Google file: the new Started the server with serverpod start. is past tense next to imperative siblings (Add, Call, Create). Either convert the whole list to past tense (matches GitHub's checklist), or keep imperative on this line for consistency with the existing items: Start the server with serverpod start.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants